Favicon

You are here: Home > API Reference > App Distribution > Build > Add new build

Add new build

Required Permission: mad.build.management.create

Add new build

POST
https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds 
curl -X POST "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "externalFileUrl": "string",
  "externalFileChecksum": "string",
  "versionName": "string",
  "tags": "string",
  "changelog": "string",
  "notifyCollaborators": true,
  "notifyEmployees": true,
  "notifyMessage": "string",
  "notifyLanguage": "es",
  "useCustomUserAudienceIds": true,
  "userAudienceIds": [
    "string"
  ],
  "filter": [
    []
  ],
  "metadata": {},
  "defaultScripts": {
    "preInstall": "string",
    "postInstall": "string",
    "audit": "string",
    "enforce": "string",
    "runner": "string"
  },
  "buildPlatform": "string",
  "packageName": "string",
  "packageVersion": "string"
}'
const response = await fetch("https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds", {
  method: "POST",
  headers: {
    Authorization: "Bearer <YOUR_API_KEY>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "externalFileUrl": "string",
    "externalFileChecksum": "string",
    "versionName": "string",
    "tags": "string",
    "changelog": "string",
    "notifyCollaborators": true,
    "notifyEmployees": true,
    "notifyMessage": "string",
    "notifyLanguage": "es",
    "useCustomUserAudienceIds": true,
    "userAudienceIds": [
      "string"
    ],
    "filter": [
      []
    ],
    "metadata": {},
    "defaultScripts": {
      "preInstall": "string",
      "postInstall": "string",
      "audit": "string",
      "enforce": "string",
      "runner": "string"
    },
    "buildPlatform": "string",
    "packageName": "string",
    "packageVersion": "string"
  }),
});

const data = await response.json();
import requests

response = requests.post(
    "https://api.applivery.io/v1/organizations/{organizationId}/apps/{applicationId}/builds",
    headers={"Authorization": "Bearer <YOUR_API_KEY>"},
    json={
      "externalFileUrl": "string",
      "externalFileChecksum": "string",
      "versionName": "string",
      "tags": "string",
      "changelog": "string",
      "notifyCollaborators": true,
      "notifyEmployees": true,
      "notifyMessage": "string",
      "notifyLanguage": "es",
      "useCustomUserAudienceIds": true,
      "userAudienceIds": [
        "string"
      ],
      "filter": [
        []
      ],
      "metadata": {},
      "defaultScripts": {
        "preInstall": "string",
        "postInstall": "string",
        "audit": "string",
        "enforce": "string",
        "runner": "string"
      },
      "buildPlatform": "string",
      "packageName": "string",
      "packageVersion": "string"
    },
)

data = response.json()

Request

Send your API key in the request header authorization
Example: Authorization: Bearer <token>

organizationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$
applicationId string
required
Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json
externalFileUrl string optional
≤ 500 characters
externalFileChecksum string optional
≤ 500 characters
versionName string optional
≤ 256 characters
tags string optional
changelog string optional
≤ 15000 characters
notifyCollaborators any optional
notifyEmployees any optional
notifyMessage string optional
≤ 1000 characters
notifyLanguage string optional
es en fr de it zh pt ru
useCustomUserAudienceIds any optional
userAudienceIds array optional
filter any optional
metadata object optional
defaultScripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
buildPlatform string optional
≤ 128 characters
packageName string optional
≤ 256 characters
packageVersion string optional
≤ 256 characters
{
    "externalFileUrl": "string",
    "externalFileChecksum": "string",
    "versionName": "string",
    "tags": "string",
    "changelog": "string",
    "notifyCollaborators": true,
    "notifyEmployees": true,
    "notifyMessage": "string",
    "notifyLanguage": "es",
    "useCustomUserAudienceIds": true,
    "userAudienceIds": [
        "string"
    ],
    "filter": [
        [
            "string"
        ]
    ],
    "metadata": {},
    "defaultScripts": {
        "preInstall": "string",
        "postInstall": "string",
        "audit": "string",
        "enforce": "string",
        "runner": "string"
    },
    "buildPlatform": "string",
    "packageName": "string",
    "packageVersion": "string"
}

Responses

200 Response application/json
status boolean required
data object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
organizationInfo object optional
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 256 characters
slug string required
≤ 256 characters
picture string optional
createdBy string optional
Match pattern: ^[a-fA-F0-9]{24}$
branding object optional
store object optional
configuration object optional
status string required
pending in_progress waiting_to_be_processed processed error
tags array [string] required
versionName string optional
≤ 256 characters
application string required
Match pattern: ^[a-fA-F0-9]{24}$
applicationInfo object optional
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string required
≤ 256 characters
slug string required
≤ 256 characters
picture string optional
changelog string optional
file object optional
originalName string optional
≤ 256 characters
mimetype string optional
≤ 128 characters
size integer required
≥ 0 · ≤ 9007199254740991
bucket string required
≤ 256 characters
key string required
≤ 256 characters
location string required
≤ 256 characters
region string optional
≤ 128 characters
storageProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
checksum string optional
≤ 256 characters
updatedAt string optional
createdAt string optional
fileSimulator object optional
originalName string optional
≤ 256 characters
mimetype string optional
≤ 128 characters
size integer required
≥ 0 · ≤ 9007199254740991
bucket string required
≤ 256 characters
key string required
≤ 256 characters
location string required
≤ 256 characters
region string optional
≤ 128 characters
storageProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
checksum string optional
≤ 256 characters
updatedAt string optional
createdAt string optional
iconFile object optional
originalName string optional
≤ 256 characters
mimetype string optional
≤ 128 characters
size integer required
≥ 0 · ≤ 9007199254740991
bucket string required
≤ 256 characters
key string required
≤ 256 characters
location string required
≤ 256 characters
region string optional
≤ 128 characters
storageProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
checksum string optional
≤ 256 characters
updatedAt string optional
createdAt string optional
info object optional
icon string optional
≤ 256 characters
ios object optional
android object optional
pkg object optional
app object optional
msi object optional
exe object optional
msixbundle object optional
appxbundle object optional
msix object optional
appx object optional
scripts object optional
package object optional
size integer optional
≥ 0 · ≤ 9007199254740991
processTime integer optional
≥ 0 · ≤ 9007199254740991
queuedTime integer optional
≥ 0 · ≤ 9007199254740991
processedVersionName string optional
≤ 128 characters
versionCode string optional
≤ 128 characters
error string optional
errorCode string optional
≤ 128 characters
os string optional
ios android aosp macos windows package
buildPlatform string optional
≤ 128 characters
deployer object required
name string optional
≤ 128 characters
info object optional
notifications object required
notifyCollaborators any required
notifyEmployees any required
message string optional
≤ 1000 characters
language string optional
es en fr de it zh pt ru
filter array [array] required
uploadedBy object optional
id string required
Match pattern: ^[a-fA-F0-9]{24}$
email string required
≤ 256 characters · Match pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ · Format: email
firstName string optional
≤ 128 characters
lastName string optional
≤ 128 characters
picture string optional
originalExtension string required
≤ 128 characters
storageProvider object required
id string required
Match pattern: ^[a-fA-F0-9]{24}$
name string optional
≤ 128 characters
region string optional
≤ 128 characters
config string optional
≤ 128 characters
provider string required
≤ 128 characters
processLogs array [object] required
dateMs integer required
≥ 0 · ≤ 9007199254740991
message string required
files array [object] required
id string required
≤ 128 characters
type string required
aab attachment original package icon
description string optional
≤ 256 characters
file object optional
metadata object optional
originalFile object optional
originalName string optional
≤ 256 characters
mimetype string optional
≤ 128 characters
size integer required
≥ 0 · ≤ 9007199254740991
bucket string required
≤ 256 characters
key string required
≤ 256 characters
location string required
≤ 256 characters
region string optional
≤ 128 characters
storageProviderId string required
Match pattern: ^[a-fA-F0-9]{24}$
checksum string optional
≤ 256 characters
updatedAt string optional
createdAt string optional
extraFiles array [object] optional
target string required
file object required
metadata object required
buildProcessor object optional
provider string required
runName string required
runId string optional
counts object optional
downloads object optional
downloadByDay object optional
downloadsByMonth object optional
externalFileUrl string optional
≤ 500 characters
disabled any optional
extension string required
hasEmmJson any required
defaultScripts object optional
preInstall string optional
postInstall string optional
audit string optional
enforce string optional
runner string optional
updatedAt string required
createdAt string required 
{
    "status": true,
    "data": {
        "id": "string",
        "organizationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "picture": "string",
            "createdBy": "string",
            "branding": {
                "logo": "string",
                "picture": "string",
                "primaryColor": "string"
            },
            "store": {
                "customDomain": "string"
            },
            "configuration": {
                "storageProvider": "string"
            }
        },
        "status": "pending",
        "tags": [
            "string"
        ],
        "versionName": "string",
        "application": "string",
        "applicationInfo": {
            "id": "string",
            "name": "string",
            "slug": "string",
            "picture": "string"
        },
        "changelog": "string",
        "file": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string",
            "updatedAt": "string",
            "createdAt": "string"
        },
        "fileSimulator": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string",
            "updatedAt": "string",
            "createdAt": "string"
        },
        "iconFile": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string",
            "updatedAt": "string",
            "createdAt": "string"
        },
        "info": {
            "icon": "string",
            "ios": {
                "plist": {
                    "CFBundleName": "string",
                    "CFBundleDisplayName": "string",
                    "CFBundleVersion": "string",
                    "CFBundleShortVersionString": "string",
                    "CFBundleIdentifier": "string",
                    "CFBundleSupportedPlatforms": [
                        "string"
                    ],
                    "MinimumOSVersion": "string",
                    "CFBundleIcons": [
                        "string"
                    ],
                    "UIDeviceFamily": [
                        "string"
                    ]
                },
                "mobileprovision": {
                    "TeamIdentifier": "string",
                    "ProvisionsAllDevices": true,
                    "ProvisionedDevices": "string",
                    "TeamName": "string",
                    "ExpirationDate": "string",
                    "signingType": "appStore"
                }
            },
            "android": {
                "versionCode": "string",
                "versionName": "string",
                "platformBuildVersionCode": "string",
                "platformBuildVersionName": "string",
                "packageName": "string",
                "minSDKVersion": "string",
                "targetSdkVersion": "string",
                "icon": "string",
                "productName": "string",
                "managedConfigurations": [
                    {
                        "key": "string",
                        "title": "string",
                        "description": "string",
                        "restrictionType": "NULL",
                        "defaultValue": "string",
                        "entries": [
                            "string"
                        ],
                        "entryValues": [
                            "string"
                        ],
                        "minValue": 0,
                        "maxValue": 0,
                        "visible": true
                    }
                ]
            },
            "pkg": {
                "CFBundleName": "string",
                "CFBundleDisplayName": "string",
                "CFBundleVersion": "string",
                "CFBundleShortVersionString": "string",
                "CFBundleIdentifier": "string",
                "CFBundleSupportedPlatforms": [
                    "string"
                ],
                "MinimumOSVersion": "string",
                "relatedPkgs": [
                    {
                        "distribution": {
                            "id": "string",
                            "active": "string",
                            "auth": "string",
                            "installKBytes": "string",
                            "onConclusion": "string",
                            "onConclusionScript": "string",
                            "version": "string",
                            "archiveKBytes": "string",
                            "packageIdentifier": "string",
                            "text": "string"
                        },
                        "plistInfo": {
                            "CFBundleName": "string",
                            "CFBundleDisplayName": "string",
                            "CFBundleVersion": "string",
                            "CFBundleShortVersionString": "string",
                            "CFBundleIdentifier": "string",
                            "CFBundleSupportedPlatforms": [
                                "string"
                            ],
                            "MinimumOSVersion": "string"
                        },
                        "iconFile": "string"
                    }
                ]
            },
            "app": {
                "CFBundleName": "string",
                "CFBundleDisplayName": "string",
                "CFBundleVersion": "string",
                "CFBundleShortVersionString": "string",
                "CFBundleIdentifier": "string",
                "CFBundleSupportedPlatforms": [
                    "string"
                ],
                "CFBundlePackageType": "string",
                "LSMinimumSystemVersion": "string"
            },
            "msi": {
                "productCode": "string",
                "productVersion": "string",
                "productName": "string",
                "manufacturer": "string"
            },
            "exe": {
                "fileSize": "string",
                "fileVersionNumber": "string",
                "fileOS": "string",
                "fileDescription": "string",
                "fileVersion": "string",
                "originalFileName": "string",
                "productName": "string",
                "productVersion": "string",
                "companyName": "string"
            },
            "msixbundle": {
                "applicationsData": [
                    {
                        "arch": "string",
                        "fileName": "string",
                        "size": "string",
                        "version": "string"
                    }
                ],
                "packageName": "string",
                "version": "string"
            },
            "appxbundle": {
                "applicationsData": [
                    {
                        "arch": "string",
                        "fileName": "string",
                        "size": "string",
                        "version": "string"
                    }
                ],
                "packageName": "string",
                "version": "string"
            },
            "msix": {
                "displayName": "string",
                "publisherDisplayName": "string",
                "version": "string",
                "arch": "string",
                "name": "string"
            },
            "appx": {
                "displayName": "string",
                "publisherDisplayName": "string",
                "version": "string",
                "arch": "string",
                "name": "string"
            },
            "scripts": {
                "preInstall": "string",
                "postInstall": "string"
            },
            "package": {
                "name": "string",
                "version": "string"
            }
        },
        "size": 0,
        "processTime": 0,
        "queuedTime": 0,
        "processedVersionName": "string",
        "versionCode": "string",
        "error": "string",
        "errorCode": "string",
        "os": "ios",
        "buildPlatform": "string",
        "deployer": {
            "name": "string",
            "info": {
                "commitMessage": "string",
                "commit": "string",
                "branch": "string",
                "triggerTimestamp": "string",
                "buildUrl": "string",
                "ciUrl": "string",
                "repositoryUrl": "string",
                "buildNumber": "string",
                "tag": "string"
            }
        },
        "notifications": {
            "notifyCollaborators": true,
            "notifyEmployees": true,
            "message": "string",
            "language": "es",
            "filter": [
                [
                    "string"
                ]
            ]
        },
        "uploadedBy": {
            "id": "string",
            "email": "[email protected]",
            "firstName": "string",
            "lastName": "string",
            "picture": "string"
        },
        "originalExtension": "string",
        "storageProvider": {
            "id": "string",
            "name": "string",
            "region": "string",
            "config": "string",
            "provider": "string"
        },
        "processLogs": [
            {
                "dateMs": 0,
                "message": "string"
            }
        ],
        "files": [
            {
                "id": "string",
                "type": "aab",
                "description": "string",
                "file": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                },
                "metadata": {}
            }
        ],
        "originalFile": {
            "originalName": "string",
            "mimetype": "string",
            "size": 0,
            "bucket": "string",
            "key": "string",
            "location": "string",
            "region": "string",
            "storageProviderId": "string",
            "checksum": "string",
            "updatedAt": "string",
            "createdAt": "string"
        },
        "extraFiles": [
            {
                "target": "string",
                "file": {
                    "originalName": "string",
                    "mimetype": "string",
                    "size": 0,
                    "bucket": "string",
                    "key": "string",
                    "location": "string",
                    "region": "string",
                    "storageProviderId": "string",
                    "checksum": "string",
                    "updatedAt": "string",
                    "createdAt": "string"
                }
            }
        ],
        "metadata": {},
        "buildProcessor": {
            "provider": "string",
            "runName": "string",
            "runId": "string"
        },
        "counts": {
            "downloads": {},
            "downloadByDay": {},
            "downloadsByMonth": {}
        },
        "externalFileUrl": "string",
        "disabled": true,
        "extension": "string",
        "hasEmmJson": true,
        "defaultScripts": {
            "preInstall": "string",
            "postInstall": "string",
            "audit": "string",
            "enforce": "string",
            "runner": "string"
        },
        "updatedAt": "string",
        "createdAt": "string"
    }
}
400 Response application/json
status boolean optional
false
error object optional
code number optional
5017
message string optional
Limit Exceeded
{
    "status": false,
    "error": {
        "code": 5006,
        "message": "No File Found in request"
    }
}
401 Response application/json
status boolean optional
false
error object optional
code number optional
4004
message string optional
Invalid Token
{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}
404 Response application/json
status boolean optional
false
error object optional
code number optional
3001
message string optional
Entity not found
{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}